| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

Public Member Functions | List of all members
nkGraphics::ProgramCompilationResult Class Referencefinal

Holds information about a complation result, from a program. More...

## Public Member Functions
| ProgramCompilationResult () noexcept
bool | getSuccess () const
nkMemory::StringView | getErrorMessage () const
SHADER_TYPE | getStage () const
void | setSuccess (bool value)
void | setErrorMessage (nkMemory::StringView message)
void | setStage (SHADER_TYPE value)

## Detailed Description

Holds information about a complation result, from a program.

## Constructor & Destructor Documentation

## ◆ ProgramCompilationResult()

nkGraphics::ProgramCompilationResult::ProgramCompilationResult | ( |  | ) |
| noexcept

Constructor.

## Member Function Documentation

## ◆ getSuccess()

bool nkGraphics::ProgramCompilationResult::getSuccess | ( |  | ) | const

Returns
  Whether the loading was a success (true) or not (false).

## ◆ getErrorMessage()

nkMemory::StringView nkGraphics::ProgramCompilationResult::getErrorMessage | ( |  | ) | const

Returns
  The error description message, if available.

## ◆ getStage()

SHADER_TYPE nkGraphics::ProgramCompilationResult::getStage | ( |  | ) | const

Returns
  The stage at which the failure occurred.

## ◆ setSuccess()

void nkGraphics::ProgramCompilationResult::setSuccess | ( | bool | value | ) |

Parameters

  value | If the compilation was a success (true) or not (false).

## ◆ setErrorMessage()

void nkGraphics::ProgramCompilationResult::setErrorMessage | ( | nkMemory::StringView | message | ) |

Parameters

  message | The error message description.

## ◆ setStage()

void nkGraphics::ProgramCompilationResult::setStage | ( | SHADER_TYPE | value | ) |

Parameters

  value | The stage at which the error occurred.

The documentation for this class was generated from the following file:

- Documentation/Headers/NilkinsGraphics/Programs/ProgramCompilationResult.h